add REST API to docs index#21183
Merged
tdcmeehan merged 1 commit intoprestodb:masterfrom Oct 20, 2023
Merged
Conversation
Contributor
Author
Thanks for the review @skairali! |
agrawalreetika
approved these changes
Oct 19, 2023
Member
agrawalreetika
left a comment
There was a problem hiding this comment.
Thank you for fixing this @steveburnett. I can see the API docs in the index now.
Contributor
Author
You're welcome! Thank you for noticing the problem and opening the issue. |
tdcmeehan
approved these changes
Oct 20, 2023
26 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
https://github.com/prestodb/presto/tree/master/presto-docs/src/main/sphinx/rest has documentation pages for API resources that are not linked to in the Presto docs.
Added presto-docs/src/main/sphinx/rest.rst as an index page for REST API.
Added a line to presto-docs/src/main/sphinx/index.rst to include the new rest file.
Motivation and Context
The documentation for node, query, stage, statement and task should be accessible in the public docs without needing the direct URL for, for example, Node Resource.
This PR is in response to and hopefully fixes Issue #21157.
Impact
Documentation only.
Test Plan
Created a local build of the documentation.
Contributor checklist
Release Notes
Please follow release notes guidelines and fill in the release notes below.